/*
 * Copyright (c) 2025 Oracle and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.helidon.data.codegen.common;

import java.util.List;
import java.util.Optional;

import io.helidon.builder.api.Option;
import io.helidon.builder.api.Prototype;
import io.helidon.common.types.TypedElementInfo;

@Prototype.Blueprint
@Prototype.CustomMethods(MethodParamsSupport.class)
interface MethodParamsBlueprint {

    /**
     * Query result ordering parameter.
     *
     * @return the ordering parameter info
     */
    Optional<TypedElementInfo> order();

    /**
     * Pageable query result parameter.
     *
     * @return the page request parameter info
     */
    Optional<TypedElementInfo> pageRequest();

    /**
     * List of common method parameters to be added to method prototype.
     *
     * @return the common method parameters
     */
    @Option.Singular
    List<TypedElementInfo> parameters();

}
